home *** CD-ROM | disk | FTP | other *** search
/ Experimental BBS Explossion 3 / Experimental BBS Explossion III.iso / compress / ar15.zip / AR.TXT < prev   
Text File  |  1993-05-01  |  11KB  |  327 lines
  1.                                  A R
  2.                              Version 1.5
  3.                               W. McCloud
  4.                            November 10, 1988
  5. ----------------------------------------------------------------------------
  6.  
  7. WHAT IS AR?:
  8.  
  9. AR is a program that allows you to run other programs which are stored inside
  10. of a .ARC (PKXARC/PKARC) file.  AR allows you to place programs in an archive
  11. (saving valuable disk space) and run them at will. This program differs from
  12. other such programs in the following ways:
  13.  
  14.         - AR allows you to specify a number of files to be De-ARC'd when
  15.           running.  This is IMPORTANT for those programs which require
  16.           associated files (overlays, data files, config files, etc) in
  17.           addition to the executable file.
  18.  
  19.         - AR also allows you to specify where you want the files De-ARC'd to
  20.           (I use a RAM disk).
  21.  
  22.         - AR also allows you to execute a batch file to control how the
  23.           De-ARC'd program runs.  (I run an AT clone at 12 MHz and when
  24.           running game programs, I often execute TSR's to slow the machine
  25.           or activate other enhancements along with running the program).
  26.  
  27.         - AR also will give you a listing of the programs which you have
  28.           set up for the above plus will give you a listing of all files
  29.           contained in the archive file.
  30.  
  31. WHAT YOU NEED:
  32.  
  33. To run AR, you need the following:
  34.  
  35.         - PKXARC located in your path.
  36.  
  37.         - An .ARC file containing the programs (and associated files) that
  38.           you wish to run from archive.
  39.  
  40.         - Enough room on a drive (Floppy, Hard, or RAM-Disk) to De-Arc the
  41.           program and files which you which to run.
  42.  
  43.         - A archive configuration file located in the same directory as your
  44.           .ARC file (see CONFIGURATION FILE below).
  45.  
  46.  
  47. CONFIGURATION FILE:
  48.  
  49. The archive configuration file contains the path that you wish to De-Arc to,
  50. a listing of KEYWORDS which are the same name as the executable file that you
  51. wish to run (less extension), the files that you wish to De-ARC (if more
  52. than one) and the batch file commands (if any) that you wish to execute along
  53. with the above.
  54.  
  55. The configuration files has the same name as the archive file with an
  56. extension of ".XXX"
  57.  
  58. Example:
  59.  
  60. Suppose you have an archive file names "GAMES.ARC".
  61.  
  62. Create an ASCII text file called "GAMES.XXX" and locate it in the same
  63. subdirectory as "GAMES.ARC".
  64.  
  65. Details:
  66.  
  67. The first line of the configuration file starts with "+" and is followed by
  68. the drive\path that you wish to De-ARC to.  (i.e. You want to De-ARC to drive
  69. E: in the root directory so the first line of your file is "+E:"
  70.  
  71. The next section of the configuration file is specific to each program that
  72. you wish to run and always starts with a line consisting of "---".
  73.  
  74. The next line of this section is CAPITALIZED and contains the KEYWORD for
  75. running your program (This is identical to the name of the executable file
  76. without extension).  (i.e. you want to run a program called INVADERS.COM, so
  77. this line is "INVADERS".
  78.  
  79. The next line contains the file or files that you wish to De-Arc (including
  80. extension).  Unless you are going to run from a batch file (see below), the
  81. first file specified must be the executable one (A good practice anyway).
  82.  
  83. The configuration file always ends with two lines of "---".
  84.  
  85. Lets see what the configuration file looks like in the above example.
  86.  
  87.         File is "GAMES.XXX":
  88.  
  89.         +E:
  90.         ---
  91.         INVADERS
  92.         invaders.com
  93.         ---
  94.         ---
  95.  
  96.  
  97. You can add other programs as follows:
  98.  
  99.         +E:
  100.         ---
  101.         INVADERS
  102.         invaders.com
  103.         ---
  104.         next program section
  105.         ---
  106.         next program section
  107.         .
  108.         .
  109.         .
  110.         ---
  111.         last program section
  112.         ---
  113.         ---
  114.  
  115.  
  116. Suppose INVADERS.COM needs another file called INVADERS.DAT to run properly.
  117. In this case you need to two files to be De-Arc'd.
  118.  
  119.         +E:
  120.         ---
  121.         INVADERS
  122.         invaders.com
  123.         invaders.dat
  124.         ---
  125.         ---
  126.  
  127. Now lets get fancy....
  128.  
  129. Now suppose that in order to run invaders properly, you also want to run a
  130. program called SLOW which will slow your machine down (in the example, the
  131. syntax for SLOW is SLOW ON to slow down and SLOW OFF to speed back up).  In
  132. this case you would want to execute a batch file containing the slow commands
  133. prior to executing INVADERS.COM.  All batch commands in the configuration
  134. file start with "*".  Thus, your file would now look like the following:
  135.  
  136.         +E:
  137.         ---
  138.         INVADERS
  139.         invaders.com
  140.         invaders.dat
  141.         *echo off
  142.         *slow on
  143.         *invaders
  144.         *slow off
  145.         ---
  146.         ---
  147.  
  148. In the above, AR would search the configuration file for the keyword
  149. INVADERS, De-Arc invaders.com and invaders.dat to drive E:, and then execute
  150. a batch file (called TEMP.BAT) containing the commands starting with "*" in
  151. the above.
  152.  
  153. SYNTAX:
  154.  
  155. AR is executed with the following choice of syntax:
  156.  
  157.   SYNTAX 1:
  158.  
  159.         AR
  160.  
  161.         Will give you built-in help on syntax and structure of the
  162.         configuration file.
  163.  
  164.  
  165.    SYNTAX 2:
  166.  
  167.         AR drive-path\archivefile\keyword
  168.  
  169.         where:
  170.  
  171.                 "drive-path" is the location of your archive file and
  172.                 configuration file, and
  173.  
  174.                 "archivefile" is the name (less extension) of your archive
  175.  
  176.                 "keyword" is the CAPITALIZED name of the executable file
  177.                 (less extension)
  178.  
  179.         In example, if you have an archive file called GAMES.ARC and
  180.         corresponding configuration file called GAMES.XXX located on
  181.         drive C: in the subdirectory \MYGAMES  and you want to run
  182.         INVADERS.COM then AR would be called:
  183.  
  184.         AR C:\MYGAMES\GAMES\INVADERS
  185.  
  186.  
  187.     SYNTAX 3:
  188.  
  189.         AR drive-path\archivefile\action
  190.  
  191.         where:
  192.  
  193.                 "drive-path" is the location of your archive file and
  194.                 configuration file, and
  195.  
  196.                 "archivefile" is the name (less extension) of your archive
  197.  
  198.         where:
  199.                 "action" is one of the following:
  200.  
  201.                 L or LISTING: is the KEYWORD used to show you all KEYWORDS
  202.                 contained in your configuration file.
  203.  
  204.                 AL or ARCLIST: is the KEYWORD used to show you a listing of
  205.                 all files contained in your .ARC file
  206.  
  207.                 ALS or ARCLIST-S: is a KEYWORD used to show you a listing of
  208.                 all files contained in your .ARC file but requires you to
  209.                 have the program SD.COM in your path.
  210.  
  211.                 ALOS or ARCLIST-OS: is the same as ARCLIST-S but will output
  212.                 the list of all files in your .ARC file to a file called
  213.                 ARCLIST.
  214.  
  215.  
  216. I know this sounds confusing but it is actually quite easy once you catch
  217. on.  Here's another example:
  218.  
  219. Background:
  220.  
  221.         I have an archive file called MISC.ARC in directory C:\MISCPROG\
  222.  
  223.         In this archive I have the following:
  224.  
  225.         A program called DDIR.EXE which can run all alone.
  226.  
  227.         A program called CHKDK.COM which needs the file CHK.DAT (also
  228.         contained in the archive MISC.ARC) to run.
  229.  
  230.         A program called EDIT.COM which needs file EDIT.DAT to run (also
  231.         in the archive MISC.ARC) and for which I would like to execute
  232.         a program called SETUP.EXE prior to running it.
  233.  
  234.         I would like to run all archived programs from "D:\TEMP"
  235.  
  236.  
  237.         In the case I would create a configuration file called MISC.XXX
  238.         (also located in directory C:\MISCPROG) containing the following:
  239.  
  240.         +D:\TEMP
  241.         ---
  242.         DDIR
  243.         ddir.exe
  244.         ---
  245.         CHKDK           {Need two files, so KEYWORD plus both filenames)
  246.         chkdk.com       {Executable file listed first}
  247.         chk.dat
  248.         ---
  249.         EDIT            (Need two files, so KEYWORD plus filenames)
  250.         edit.com
  251.         edit.dat
  252.         *echo off       (These three lines will be placed in a batch
  253.         *setup           file called D:\TEMP\TEMP.BAT and then executed)
  254.         *edit
  255.         ---
  256.         ---
  257.  
  258.         To run EDIT.COM, type "AR C:\MISCPROG\MISC\EDIT"
  259.  
  260.         To run CHKDK.COM, type "AR C:\MISCPROG\MISC\CHKDK"
  261.  
  262.         To get a listing of all programs contained in MISC.XXX, type
  263.         "AR C:\MISCPROG\MISC\LISTING" or "AR C:\MISCPROG\MISC\L"
  264.  
  265.         To get a listing of all programs contained in "MISC.ARC" type
  266.         "AR C:\MISCPROG\MISC\ARCLIST" or "AR C:\MISCPROG\MISC\ARCLIST-S"
  267.         or "AR C:\MISCPROG\MISC\ARCLIST-OS".  You can substitue shorter
  268.         keywords (abbreviations) if you like.
  269.  
  270.  
  271. WHEN ALL DONE:
  272.  
  273. As AR executes, it will change to the directory\path specified in the first
  274. line of the configuration file, extract all files associated with the
  275. KEYWORD from your archive into this directory, execute either the executable
  276. program specified by the first file listed after the KEYWORD or create and
  277. execute TEMP.BAT (if any batch commands are associated with the KEYWORD) and
  278. when all done, erase all files created.
  279.  
  280.  
  281. PROGRAM STATUS:
  282.  
  283. This program is released into the public domain.  You are free to use and
  284. distribute this as you like.  I, however, take no liability for ANYTHING
  285. that happens when you use it.
  286.  
  287. I think you'll like AR, it saves a lot of expensive diskspace and doesn't
  288. slow down running a program very much (HINT: Keep your .ARCs reasonable
  289. in size since most of the time overhead associated with AR is wrapped up
  290. in searching the configuration file and archive (the bigger the .ARC is,
  291. the longer this takes)).
  292.  
  293. Have fun!!!
  294.  
  295.  
  296. REVISION HISTORY:
  297.  
  298. Version 1.5:
  299.  
  300. Corrected documentation to reflect the fact that the first file specified
  301. after a KEYWORD in the configuration file must be the executable file.  Also
  302. added abbreviations for LISTING, ARCLIST, etc.
  303.  
  304. Version 1.4:
  305.  
  306. Added built-in help function by typing in "AR" only.  Also added additional
  307. KEYWORDS for listing contents of .ARC file.  Corrected bug in previous versions
  308. that prevented proper use of sub-directories in the location (via configuration
  309. file) to De-Arc to.
  310.  
  311. Version 1.3:
  312.  
  313. Not released, interm version.  Added ability to work with shell programs which
  314. padded the command line with extra space characters (ASCII=32) to the right
  315. of text.  Fixed a major "bug" in the documentation that incorrectly stated that
  316. if you wanted to De-Arc a single program, you only needed to list the KEYWORD
  317. in the configuration file (NOT SO, I'M SORRY TO SAY.  You need both the keyword
  318. and the name of the program.ext to De-Arc).
  319.  
  320. Version 1.2:
  321.  
  322. First release to Public Domain.
  323.  
  324.  
  325. Bill McCloud
  326. November 10, 1988
  327.